home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / batchut / batman.zip / BATMAN.DOC next >
Text File  |  1988-07-20  |  26KB  |  886 lines
  1.  
  2.  
  3.  
  4.                                    BATMAN
  5.                             (BATch job MANager)
  6.  
  7.                   A Tool For Adding Pizazz To Batch Files
  8.                                 Version 1.1
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28. Presented to the public by:   GS Communications
  29.                               PO Box 5962
  30.                               Titusville, FL 32783
  31.  
  32.  
  33.  
  34.  
  35.  
  36. First, the copyright and disclaimers;
  37.  
  38.  
  39.  
  40. * BATMAN is the property of GS Communications with authoring rights by
  41.   Guy Smith. GS Communications reserves all rights and privileges
  42.   afforded by copyright statues.
  43.  
  44. * BATMAN is released to the public as a Shareware offering. This means
  45.   you may use the program as you like with no restrictions. The author
  46.   asks that you make a one dollar contribution if you receive any
  47.   benefit from the program at all.
  48.  
  49. * Business concerns, and this includes sole proprietorships,
  50.   partnerships, corporations, nonprofit organizations, government agencies,
  51.   and cartels must pay a one time, five dollar site licensing fee.
  52.  
  53. * GS Communications offers a cash reward for evidence of business
  54.   concerns that use BATMAN, or any other software produced by GS
  55.   Communications, without paying the requisite fee.
  56.  
  57. * GS Communications and Guy Smith waive all responsibility for the
  58.   usefulness of the product or any damage it may inadvertently cause
  59.   (though it is a clean as clean can be).
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.                                      2
  93.  
  94.  
  95.  
  96. Just What In The Heck Is BATMAN Anyhow:
  97.  
  98.  
  99.      BATMAN is a comic book character that achieved zenith popularity
  100.      during the run of a network television show of the same name
  101.      which aired during the 1960's.
  102.  
  103.      But that's irrelevant. This program, BATMAN, is a tool for
  104.      bringing a little life an pizazz to your MS-DOS batch files. The
  105.      program allows you to do a number of tricks which are either
  106.  
  107.  
  108.           1) impossible to with conventual MS-DOS commands
  109.           2) require cryptic ASNI code to produce or
  110.           3) would otherwise require a bunch of separate utilities
  111.  
  112.  
  113.      I'll get into more detail in a moment. For now we can say that
  114.      BATMAN will allow you to;
  115.  
  116.  
  117.           * Make the speaker beep for any number of times, at any tone
  118.             and with any duration of tone and gap between the tones
  119.  
  120.           * Play 'canned' songs and interesting sound effects
  121.  
  122.           * Switch to any video mode (this saves floppy disc users
  123.             from having to have the MODE program on every disc).
  124.             Support is included for 43 lines on EGA systems and 50
  125.             lines on VGAs.
  126.  
  127.           * Get responses from users and thus allows the batch file to
  128.             react to their answers
  129.  
  130.           * Set foreground and background colors for text
  131.  
  132.           * Write text at any position on the screen
  133.  
  134.           * Solicit "Yes or no" response with many variations.
  135.  
  136.           * Draw boxes with border for putting detail text into
  137.  
  138.           * And many other stunts
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.                                      3
  154.  
  155.  
  156.  
  157. NEW AND IMPROVED:
  158.  
  159.         I have made a number of improvement since 1.0. Briefly they are;
  160.  
  161.         1) The YORN command doesn't make a mess of the screen any more.
  162.            Originally it produced an error message which, if the user made
  163.            too many mistakes, would cause the screen to scroll away. Now an
  164.            error window opens, tells the user to try a "yes or no" type
  165.            answer, and then disappears with the first keystroke. I have used
  166.            a set text attribute for the error box (red background, black
  167.            foreground), which may interfere with your choice. Later I'll
  168.            write in a test of colors and change them dynamically.
  169.  
  170.         2) New commands which clear the screen (an oversight in the first
  171.            version), draw a box and report the current video mode.
  172.  
  173.         3) New sound effects/songs up to five from three (there should be
  174.            more, but I've been busy).
  175.  
  176.         4) Process BATMAN commands from a file for faster response.
  177.  
  178.  
  179.      Sound good? Well flip the page and I'll start describing the
  180.      program.
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.                                      4
  215.  
  216.  
  217.  
  218. How Do You Use BATMAN:
  219.  
  220.  
  221.      Well, first you use the Bat Telephone, dial 1-800-BAT-CAVE . . .
  222.  
  223.      I'm sorry about these silly outburst, but this is a silly day.
  224.      Besides, the name of the program makes for obvious jokes.
  225.  
  226.      To run BATMAN, simply type BATMAN followed by one of the
  227.      supported parameters. Since BATMAN is designed for use in batch
  228.      files, you will probably want to experiment by building your own.
  229.      In this package, there is a batch file named DEMO.BAT which shows
  230.      off some of the features of BATMAN.
  231.  
  232.      Each of the parameters is a command name which can be abbreviated
  233.      to three letters (it was four in version 1.0, but I found a good reason
  234.      to decrease the character count). For example, the following two
  235.      commands function identically;
  236.  
  237.  
  238.                BATMAN VIDEOMODE(CO80)
  239.                BATMAN VIDE(CO80)
  240.  
  241.  
  242.      You can use more than three letters if you like. The only
  243.      restriction is that the first four characters must match a
  244.      command name exactly. You could say;
  245.  
  246.  
  247.                BATMAN VIDEO_MODE_HAS_POWER(CO80)
  248.  
  249.  
  250.      without making the program bomb. As you may note, the VIDEO
  251.      command has a parameter all its own, which is encased in
  252.      parenthesis. Most commands have such a parameters, some have
  253.      several, and a few have none at all. Don't let this bother you.
  254.      If you ever forget how to structure a parameter, just type in
  255.      BATMAN with no commands (or with the HELP command) and a short
  256.      list of commands and parameters will be displayed.
  257.  
  258.      You can combine commands on a single line. This is advised since
  259.      each command line that calls BATMAN causes the computer to hunt
  260.      down the program, allocate memory, load and initialize the
  261.      program, and more time consuming processes.  This new version also
  262.      allows you to use an entire file of BATMAN commands which makes the
  263.      process even faster.  The only time you need to exit BATMAN is when a
  264.      batch file decision is required (i.e. the IF statement).
  265.  
  266.      Finally, I suggest you keep BATMAN in the first directory in your
  267.      path statement (this section really only applies to hard disc
  268.      users, so floppy folks can read on). My \UTIL directory is first
  269.      in the path list and I keep BATMAN at the top of the directory
  270.      (there are a number of utilities that allow you to shuffle the
  271.      order in which files appear in a subdirectory). This speeds up
  272.      batch file execution greatly and saves some wear and tear on the
  273.      drive.
  274.  
  275.                                      5
  276.  
  277.  
  278.  
  279.  
  280.      Some much for the basics. Flip the page and we'll learn about
  281.      each of the parameters.
  282.  
  283.  
  284. BEEP(num,dur,frq,gap)
  285.  
  286.      This command produces beeps of a specific tone, duration and
  287.      delay (i.e. no sound at all) between beeps.
  288.  
  289.  
  290.           num: The number of beeps you want to hear.
  291.  
  292.           dur: The length of the beep in milliseconds.
  293.  
  294.           frq: The frequency, or tone of the beep.
  295.  
  296.           gap: The delay between beeps.
  297.  
  298.  
  299.      Use numbers only. Using character will produce an error message
  300.      (try it, you'll be surprised). You can use negative numbers, but
  301.      the program ignores the negative value, and uses the absolute
  302.      value. The commas are the only delimiters allowed in BATMAN. The
  303.      command;
  304.  
  305.  
  306.           BATMAN BEEP(3,500,440,250)
  307.  
  308.  
  309.      produces three beeps. Each beep is 1/2 second long and is played
  310.      at 440 Hz (or middle A). Silence is heard for 1/4 second between
  311.      each beep.
  312.  
  313.      I decided to leave the parameters as numbers instead of devising
  314.      some coding scheme. This saves program size and processing speed
  315.      and makes BATMAN run faster. Since BATMAN